<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     Copyright 2009-2010    Regents of the University of Colorado.<a name="line.2"></a>
<FONT color="green">003</FONT>     All rights reserved.<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>     Licensed under the Apache License, Version 2.0 (the "License");<a name="line.5"></a>
<FONT color="green">006</FONT>     you may not use this file except in compliance with the License.<a name="line.6"></a>
<FONT color="green">007</FONT>     You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.uimafit.pipeline;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import static org.uimafit.factory.CollectionReaderFactory.createCollectionReader;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    import java.io.IOException;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.util.ArrayList;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.util.List;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.uima.UIMAException;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.uima.analysis_engine.AnalysisEngine;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.uima.analysis_engine.AnalysisEngineDescription;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.uima.analysis_engine.AnalysisEngineProcessException;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.uima.cas.CAS;<a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.uima.collection.CollectionReader;<a name="line.31"></a>
<FONT color="green">032</FONT>    import org.apache.uima.collection.CollectionReaderDescription;<a name="line.32"></a>
<FONT color="green">033</FONT>    import org.apache.uima.jcas.JCas;<a name="line.33"></a>
<FONT color="green">034</FONT>    import org.apache.uima.resource.Resource;<a name="line.34"></a>
<FONT color="green">035</FONT>    import org.apache.uima.resource.metadata.ResourceMetaData;<a name="line.35"></a>
<FONT color="green">036</FONT>    import org.apache.uima.util.CasCreationUtils;<a name="line.36"></a>
<FONT color="green">037</FONT>    import org.uimafit.factory.AnalysisEngineFactory;<a name="line.37"></a>
<FONT color="green">038</FONT>    <a name="line.38"></a>
<FONT color="green">039</FONT>    /**<a name="line.39"></a>
<FONT color="green">040</FONT>     * @author Steven Bethard, Philip Ogren<a name="line.40"></a>
<FONT color="green">041</FONT>     * @author Richard Eckart de Castilho<a name="line.41"></a>
<FONT color="green">042</FONT>     *<a name="line.42"></a>
<FONT color="green">043</FONT>     */<a name="line.43"></a>
<FONT color="green">044</FONT>    public final class SimplePipeline {<a name="line.44"></a>
<FONT color="green">045</FONT>            private SimplePipeline() {<a name="line.45"></a>
<FONT color="green">046</FONT>                    // This class is not meant to be instantiated<a name="line.46"></a>
<FONT color="green">047</FONT>            }<a name="line.47"></a>
<FONT color="green">048</FONT>    <a name="line.48"></a>
<FONT color="green">049</FONT>            /**<a name="line.49"></a>
<FONT color="green">050</FONT>             * Run the CollectionReader and AnalysisEngines as a pipeline. After processing all CASes<a name="line.50"></a>
<FONT color="green">051</FONT>             * provided by the reader, the method calls {@link AnalysisEngine#collectionProcessComplete()<a name="line.51"></a>
<FONT color="green">052</FONT>             * collectionProcessComplete()} on the engines and {@link Resource#destroy() destroy()} on all<a name="line.52"></a>
<FONT color="green">053</FONT>             * engines.<a name="line.53"></a>
<FONT color="green">054</FONT>             *<a name="line.54"></a>
<FONT color="green">055</FONT>             * @param reader<a name="line.55"></a>
<FONT color="green">056</FONT>             *            The CollectionReader that loads the documents into the CAS.<a name="line.56"></a>
<FONT color="green">057</FONT>             * @param descs<a name="line.57"></a>
<FONT color="green">058</FONT>             *            Primitive AnalysisEngineDescriptions that process the CAS, in order. If you have a<a name="line.58"></a>
<FONT color="green">059</FONT>             *            mix of primitive and aggregate engines, then please create the AnalysisEngines<a name="line.59"></a>
<FONT color="green">060</FONT>             *            yourself and call the other runPipeline method.<a name="line.60"></a>
<FONT color="green">061</FONT>             * @throws UIMAException<a name="line.61"></a>
<FONT color="green">062</FONT>             * @throws IOException<a name="line.62"></a>
<FONT color="green">063</FONT>             */<a name="line.63"></a>
<FONT color="green">064</FONT>            public static void runPipeline(CollectionReader reader, AnalysisEngineDescription... descs)<a name="line.64"></a>
<FONT color="green">065</FONT>                            throws UIMAException, IOException {<a name="line.65"></a>
<FONT color="green">066</FONT>                    // Create the components<a name="line.66"></a>
<FONT color="green">067</FONT>                    AnalysisEngine[] engines = createEngines(descs);<a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>                    // Run the pipeline<a name="line.69"></a>
<FONT color="green">070</FONT>                    runPipeline(reader, engines);<a name="line.70"></a>
<FONT color="green">071</FONT>    <a name="line.71"></a>
<FONT color="green">072</FONT>                    // Destroy the components<a name="line.72"></a>
<FONT color="green">073</FONT>                    destroy(engines);<a name="line.73"></a>
<FONT color="green">074</FONT>            }<a name="line.74"></a>
<FONT color="green">075</FONT>    <a name="line.75"></a>
<FONT color="green">076</FONT>            /**<a name="line.76"></a>
<FONT color="green">077</FONT>             * Run the CollectionReader and AnalysisEngines as a pipeline. After processing all CASes<a name="line.77"></a>
<FONT color="green">078</FONT>             * provided by the reader, the method calls {@link AnalysisEngine#collectionProcessComplete()<a name="line.78"></a>
<FONT color="green">079</FONT>             * collectionProcessComplete()} on the engines, {@link CollectionReader#close() close()} on the<a name="line.79"></a>
<FONT color="green">080</FONT>             * reader and {@link Resource#destroy() destroy()} on the reader and all engines.<a name="line.80"></a>
<FONT color="green">081</FONT>             *<a name="line.81"></a>
<FONT color="green">082</FONT>             * @param readerDesc<a name="line.82"></a>
<FONT color="green">083</FONT>             *            The CollectionReader that loads the documents into the CAS.<a name="line.83"></a>
<FONT color="green">084</FONT>             * @param descs<a name="line.84"></a>
<FONT color="green">085</FONT>             *            Primitive AnalysisEngineDescriptions that process the CAS, in order. If you have a<a name="line.85"></a>
<FONT color="green">086</FONT>             *            mix of primitive and aggregate engines, then please create the AnalysisEngines<a name="line.86"></a>
<FONT color="green">087</FONT>             *            yourself and call the other runPipeline method.<a name="line.87"></a>
<FONT color="green">088</FONT>             * @throws UIMAException<a name="line.88"></a>
<FONT color="green">089</FONT>             * @throws IOException<a name="line.89"></a>
<FONT color="green">090</FONT>             */<a name="line.90"></a>
<FONT color="green">091</FONT>            public static void runPipeline(CollectionReaderDescription readerDesc, AnalysisEngineDescription... descs)<a name="line.91"></a>
<FONT color="green">092</FONT>                            throws UIMAException, IOException {<a name="line.92"></a>
<FONT color="green">093</FONT>                    // Create the components<a name="line.93"></a>
<FONT color="green">094</FONT>                    AnalysisEngine[] engines = createEngines(descs);<a name="line.94"></a>
<FONT color="green">095</FONT>                    CollectionReader reader = createCollectionReader(readerDesc);<a name="line.95"></a>
<FONT color="green">096</FONT>    <a name="line.96"></a>
<FONT color="green">097</FONT>                    // Run the pipeline<a name="line.97"></a>
<FONT color="green">098</FONT>                    runPipeline(reader, engines);<a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>                    // Destroy the components<a name="line.100"></a>
<FONT color="green">101</FONT>                    reader.close();<a name="line.101"></a>
<FONT color="green">102</FONT>                    destroy(reader);<a name="line.102"></a>
<FONT color="green">103</FONT>                    destroy(engines);<a name="line.103"></a>
<FONT color="green">104</FONT>            }<a name="line.104"></a>
<FONT color="green">105</FONT>    <a name="line.105"></a>
<FONT color="green">106</FONT>            private static AnalysisEngine[] createEngines(AnalysisEngineDescription... descs)<a name="line.106"></a>
<FONT color="green">107</FONT>                            throws UIMAException {<a name="line.107"></a>
<FONT color="green">108</FONT>                    AnalysisEngine[] engines = new AnalysisEngine[descs.length];<a name="line.108"></a>
<FONT color="green">109</FONT>                    for (int i = 0; i &lt; engines.length; ++i) {<a name="line.109"></a>
<FONT color="green">110</FONT>                            if (descs[i].isPrimitive()) {<a name="line.110"></a>
<FONT color="green">111</FONT>                                    engines[i] = AnalysisEngineFactory.createPrimitive(descs[i]);<a name="line.111"></a>
<FONT color="green">112</FONT>                            }<a name="line.112"></a>
<FONT color="green">113</FONT>                            else {<a name="line.113"></a>
<FONT color="green">114</FONT>                                    engines[i] = AnalysisEngineFactory.createAggregate(descs[i]);<a name="line.114"></a>
<FONT color="green">115</FONT>                            }<a name="line.115"></a>
<FONT color="green">116</FONT>                    }<a name="line.116"></a>
<FONT color="green">117</FONT>                    return engines;<a name="line.117"></a>
<FONT color="green">118</FONT>    <a name="line.118"></a>
<FONT color="green">119</FONT>            }<a name="line.119"></a>
<FONT color="green">120</FONT>    <a name="line.120"></a>
<FONT color="green">121</FONT>            /**<a name="line.121"></a>
<FONT color="green">122</FONT>             * Provides a simple way to run a pipeline for a given collection reader and sequence of<a name="line.122"></a>
<FONT color="green">123</FONT>             * analysis engines. After processing all CASes provided by the reader, the method calls<a name="line.123"></a>
<FONT color="green">124</FONT>             * {@link AnalysisEngine#collectionProcessComplete() collectionProcessComplete()} on the<a name="line.124"></a>
<FONT color="green">125</FONT>             * engines.<a name="line.125"></a>
<FONT color="green">126</FONT>             *<a name="line.126"></a>
<FONT color="green">127</FONT>             * @param reader<a name="line.127"></a>
<FONT color="green">128</FONT>             *            a collection reader<a name="line.128"></a>
<FONT color="green">129</FONT>             * @param engines<a name="line.129"></a>
<FONT color="green">130</FONT>             *            a sequence of analysis engines<a name="line.130"></a>
<FONT color="green">131</FONT>             * @throws UIMAException<a name="line.131"></a>
<FONT color="green">132</FONT>             * @throws IOException<a name="line.132"></a>
<FONT color="green">133</FONT>             */<a name="line.133"></a>
<FONT color="green">134</FONT>            public static void runPipeline(CollectionReader reader, AnalysisEngine... engines)<a name="line.134"></a>
<FONT color="green">135</FONT>                            throws UIMAException, IOException {<a name="line.135"></a>
<FONT color="green">136</FONT>                    List&lt;ResourceMetaData&gt; metaData = new ArrayList&lt;ResourceMetaData&gt;();<a name="line.136"></a>
<FONT color="green">137</FONT>                    metaData.add(reader.getMetaData());<a name="line.137"></a>
<FONT color="green">138</FONT>                    for (AnalysisEngine engine : engines) {<a name="line.138"></a>
<FONT color="green">139</FONT>                            metaData.add(engine.getMetaData());<a name="line.139"></a>
<FONT color="green">140</FONT>                    }<a name="line.140"></a>
<FONT color="green">141</FONT>    <a name="line.141"></a>
<FONT color="green">142</FONT>                    CAS cas = CasCreationUtils.createCas(metaData);<a name="line.142"></a>
<FONT color="green">143</FONT>                    while (reader.hasNext()) {<a name="line.143"></a>
<FONT color="green">144</FONT>                            reader.getNext(cas);<a name="line.144"></a>
<FONT color="green">145</FONT>                            runPipeline(cas, engines);<a name="line.145"></a>
<FONT color="green">146</FONT>                            cas.reset();<a name="line.146"></a>
<FONT color="green">147</FONT>                    }<a name="line.147"></a>
<FONT color="green">148</FONT>    <a name="line.148"></a>
<FONT color="green">149</FONT>                    collectionProcessComplete(engines);<a name="line.149"></a>
<FONT color="green">150</FONT>            }<a name="line.150"></a>
<FONT color="green">151</FONT>    <a name="line.151"></a>
<FONT color="green">152</FONT>            /**<a name="line.152"></a>
<FONT color="green">153</FONT>             * Run a sequence of {@link AnalysisEngine analysis engines} over a {@link JCas}. The result of<a name="line.153"></a>
<FONT color="green">154</FONT>             * the analysis can be read from the JCas.<a name="line.154"></a>
<FONT color="green">155</FONT>             *<a name="line.155"></a>
<FONT color="green">156</FONT>             * @param jCas<a name="line.156"></a>
<FONT color="green">157</FONT>             *            the jCas to process<a name="line.157"></a>
<FONT color="green">158</FONT>             * @param descs<a name="line.158"></a>
<FONT color="green">159</FONT>             *            a sequence of analysis engines to run on the jCas<a name="line.159"></a>
<FONT color="green">160</FONT>             * @throws UIMAException<a name="line.160"></a>
<FONT color="green">161</FONT>             * @throws IOException<a name="line.161"></a>
<FONT color="green">162</FONT>             */<a name="line.162"></a>
<FONT color="green">163</FONT>            public static void runPipeline(JCas jCas, AnalysisEngineDescription... descs)<a name="line.163"></a>
<FONT color="green">164</FONT>                            throws UIMAException, IOException {<a name="line.164"></a>
<FONT color="green">165</FONT>                    // Create the components<a name="line.165"></a>
<FONT color="green">166</FONT>                    AnalysisEngine[] engines = createEngines(descs);<a name="line.166"></a>
<FONT color="green">167</FONT>    <a name="line.167"></a>
<FONT color="green">168</FONT>                    // Run the pipeline<a name="line.168"></a>
<FONT color="green">169</FONT>                    runPipeline(jCas, engines);<a name="line.169"></a>
<FONT color="green">170</FONT>    <a name="line.170"></a>
<FONT color="green">171</FONT>                    // Destroy the components<a name="line.171"></a>
<FONT color="green">172</FONT>                    destroy(engines);<a name="line.172"></a>
<FONT color="green">173</FONT>            }<a name="line.173"></a>
<FONT color="green">174</FONT>    <a name="line.174"></a>
<FONT color="green">175</FONT>            /**<a name="line.175"></a>
<FONT color="green">176</FONT>             * Run a sequence of {@link AnalysisEngine analysis engines} over a {@link JCas}. This method<a name="line.176"></a>
<FONT color="green">177</FONT>             * does not {@link AnalysisEngine#destroy() destroy} the engines or send them other events like<a name="line.177"></a>
<FONT color="green">178</FONT>             * {@link AnalysisEngine#collectionProcessComplete()}. This is left to the caller.<a name="line.178"></a>
<FONT color="green">179</FONT>             *<a name="line.179"></a>
<FONT color="green">180</FONT>             * @param jCas<a name="line.180"></a>
<FONT color="green">181</FONT>             *            the jCas to process<a name="line.181"></a>
<FONT color="green">182</FONT>             * @param engines<a name="line.182"></a>
<FONT color="green">183</FONT>             *            a sequence of analysis engines to run on the jCas<a name="line.183"></a>
<FONT color="green">184</FONT>             * @throws UIMAException<a name="line.184"></a>
<FONT color="green">185</FONT>             * @throws IOException<a name="line.185"></a>
<FONT color="green">186</FONT>             */<a name="line.186"></a>
<FONT color="green">187</FONT>            public static void runPipeline(JCas jCas, AnalysisEngine... engines) throws UIMAException,<a name="line.187"></a>
<FONT color="green">188</FONT>                            IOException {<a name="line.188"></a>
<FONT color="green">189</FONT>                    for (AnalysisEngine engine : engines) {<a name="line.189"></a>
<FONT color="green">190</FONT>                            engine.process(jCas);<a name="line.190"></a>
<FONT color="green">191</FONT>                    }<a name="line.191"></a>
<FONT color="green">192</FONT>            }<a name="line.192"></a>
<FONT color="green">193</FONT>    <a name="line.193"></a>
<FONT color="green">194</FONT>            /**<a name="line.194"></a>
<FONT color="green">195</FONT>             * Run a sequence of {@link AnalysisEngine analysis engines} over a {@link CAS}. This method<a name="line.195"></a>
<FONT color="green">196</FONT>             * does not {@link AnalysisEngine#destroy() destroy} the engines or send them other events like<a name="line.196"></a>
<FONT color="green">197</FONT>             * {@link AnalysisEngine#collectionProcessComplete()}. This is left to the caller.<a name="line.197"></a>
<FONT color="green">198</FONT>             *<a name="line.198"></a>
<FONT color="green">199</FONT>             * @param cas<a name="line.199"></a>
<FONT color="green">200</FONT>             *            the CAS to process<a name="line.200"></a>
<FONT color="green">201</FONT>             * @param engines<a name="line.201"></a>
<FONT color="green">202</FONT>             *            a sequence of analysis engines to run on the jCas<a name="line.202"></a>
<FONT color="green">203</FONT>             * @throws UIMAException<a name="line.203"></a>
<FONT color="green">204</FONT>             * @throws IOException<a name="line.204"></a>
<FONT color="green">205</FONT>             */<a name="line.205"></a>
<FONT color="green">206</FONT>            public static void runPipeline(CAS cas, AnalysisEngine... engines) throws UIMAException,<a name="line.206"></a>
<FONT color="green">207</FONT>                            IOException {<a name="line.207"></a>
<FONT color="green">208</FONT>                    for (AnalysisEngine engine : engines) {<a name="line.208"></a>
<FONT color="green">209</FONT>                            engine.process(cas);<a name="line.209"></a>
<FONT color="green">210</FONT>                    }<a name="line.210"></a>
<FONT color="green">211</FONT>            }<a name="line.211"></a>
<FONT color="green">212</FONT>    <a name="line.212"></a>
<FONT color="green">213</FONT>            /**<a name="line.213"></a>
<FONT color="green">214</FONT>             * Notify a set of {@link AnalysisEngine analysis engines} that the collection process is complete.<a name="line.214"></a>
<FONT color="green">215</FONT>             */<a name="line.215"></a>
<FONT color="green">216</FONT>            private static void collectionProcessComplete(AnalysisEngine... engines)<a name="line.216"></a>
<FONT color="green">217</FONT>                            throws AnalysisEngineProcessException {<a name="line.217"></a>
<FONT color="green">218</FONT>                    for (AnalysisEngine e : engines) {<a name="line.218"></a>
<FONT color="green">219</FONT>                            e.collectionProcessComplete();<a name="line.219"></a>
<FONT color="green">220</FONT>                    }<a name="line.220"></a>
<FONT color="green">221</FONT>            }<a name="line.221"></a>
<FONT color="green">222</FONT>    <a name="line.222"></a>
<FONT color="green">223</FONT>            /**<a name="line.223"></a>
<FONT color="green">224</FONT>             * Destroy a set of {@link Resource resources}.<a name="line.224"></a>
<FONT color="green">225</FONT>             */<a name="line.225"></a>
<FONT color="green">226</FONT>            private static void destroy(Resource... resources)<a name="line.226"></a>
<FONT color="green">227</FONT>            {<a name="line.227"></a>
<FONT color="green">228</FONT>                    for (Resource r : resources) {<a name="line.228"></a>
<FONT color="green">229</FONT>                            r.destroy();<a name="line.229"></a>
<FONT color="green">230</FONT>                    }<a name="line.230"></a>
<FONT color="green">231</FONT>            }<a name="line.231"></a>
<FONT color="green">232</FONT>    }<a name="line.232"></a>




























































</PRE>
</BODY>
</HTML>
